Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Collapse PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/files/{fileId}/{version}/references?configId={configId}&folderId={folderId}
PDM Pro API Web Service > File Resource Group : api/{vaultName}/files/{fileId}/{version}/references?configId={configId}&folderId={folderId} (Get)
Description
GET: api/{VaultName}/files/{FileID}/{Version}/references Get file references

 

Gets the top level file references of the specified file.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (required)string
fileId(URI parameter) File ID (required)integer
version(URI parameter) Version (required)integer
configId(URI parameter) Configuration ID (default value is -1)integer
folderId(URI parameter) Folder ID (default value is 0)integer
File

(Response) A FileInfo object that consists of:

File object that consists of:

   FileId (integer)

   File Name (string)

Folder object that consists of:

   FolderId (integer)

   FolderPath

Version (integer)

Config object that consists of :

   ConfigurationName (string)

   ConfigurationId (integer)

 

Member of FileRef model

 

FileInfo
IsCyclic

(Response) Whether the file reference is self-referential

 

Member of FileRef model

 

boolean
IsToolbox

(Response) Whether the file reference is a toolbox item

 

Member of FileRef model

 

integer
ObjectType

(Response) PweObjectType model; one of:

   ObjType_NoObject = 0

   ObjType_File = 1

   ObjType_InternalComponent = 2

   ObjType_SavedBOM = 3

   ObjType_Item = 4

   ObjType_CutListItem = 5

 

Member of FileRef model

 

PweObjectType
Warnings

(Response) An array of BaseWarningModels; each BaseWarningModel consists of:

   Message  (string)

   IsBlocking (boolean)

   IsError (boolean)

 

Member of FileRef model

 

Collection of BaseWarningModel
References

(Response) The file reference's references; an array of FileRefs; each FileRef consists of:

   File (FileInfo)

   IsCyclic (boolean)

   IsToolbox (integer)

   ObjectType (PweObjectType)

   Warnings (Array of BaseWarningModels)

   References (Array of FileRefs)

 

Member of FileRef model; see Remarks

 

Collection of FileRef
See Also
File Resource Group | PDM Pro API Web Service



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/files/{fileId}/{version}/references?configId={configId}&folderId={folderId} (Get)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2023 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.48